<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboItemContainer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="monikers.html" title="Monikers">
<link rel="prev" href="libbonobo-bonobo-item-handler.html" title="BonoboItemHandler">
<link rel="next" href="libbonobo-bonobo-moniker-context.html" title="bonobo-moniker-context">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libbonobo-bonobo-item-handler.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="monikers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-moniker-context.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-item-container.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-item-container.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonobo-bonobo-item-container.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libbonobo-bonobo-item-container.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-item-container"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-item-container.top_of_page"></a>BonoboItemContainer</span></h2>
<p>BonoboItemContainer — this implements a simple container interface for compound document containers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-item-container.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboItemContainer"></a><pre class="synopsis">                    <a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer-struct" title="BonoboItemContainer">BonoboItemContainer</a>;
                    <a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainerClass" title="BonoboItemContainerClass">BonoboItemContainerClass</a>;
<a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="returnvalue">BonoboItemContainer</span></a> * <a class="link" href="libbonobo-bonobo-item-container.html#bonobo-item-container-new" title="bonobo_item_container_new ()">bonobo_item_container_new</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonobo-bonobo-item-container.html#bonobo-item-container-add" title="bonobo_item_container_add ()">bonobo_item_container_add</a>           (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="type">BonoboItemContainer</span></a> *container</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a> *object</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonobo-bonobo-item-container.html#bonobo-item-container-remove-by-name" title="bonobo_item_container_remove_by_name ()">bonobo_item_container_remove_by_name</a>
                                                        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="type">BonoboItemContainer</span></a> *container</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-item-container.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
         +----BonoboItemContainer
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-item-container.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer-get-object" title='The "get-object" signal'>get-object</a>"                                     : Run Last
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-item-container.description"></a><h2>Description</h2>
<p>
This implementation is mostly deprecated, see <a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="type">BonoboItemHandler</span></a>
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-item-container.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboItemContainer-struct"></a><h3>BonoboItemContainer</h3>
<pre class="programlisting">typedef struct _BonoboItemContainer BonoboItemContainer;</pre>
<p>
Object that implements Bonobo::ItemHandler
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboItemContainerClass"></a><h3>BonoboItemContainerClass</h3>
<pre class="programlisting">typedef struct {
	BonoboObjectClass parent_class;

	POA_Bonobo_ItemContainer__epv epv;

	Bonobo_Unknown (*get_object) (BonoboItemContainer *item_container,
				      CORBA_char          *item_name,
				      CORBA_boolean        only_if_exists,
				      CORBA_Environment   *ev);
} BonoboItemContainerClass;
</pre>
<p>
<a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="type">BonoboItemContainer</span></a>'s class
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-item-container-new"></a><h3>bonobo_item_container_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="returnvalue">BonoboItemContainer</span></a> * bonobo_item_container_new         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new BonoboItemContainer object.  These are used to hold
client sites.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The newly created BonoboItemContainer object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-item-container-add"></a><h3>bonobo_item_container_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_item_container_add           (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="type">BonoboItemContainer</span></a> *container</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a> *object</code></em>);</pre>
<p>
Adds the <em class="parameter"><code>object</code></em> to the list of objects managed by this
container
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td>The object to operate on.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The name of the object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>The object to add to the container
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-item-container-remove-by-name"></a><h3>bonobo_item_container_remove_by_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_item_container_remove_by_name
                                                        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="type">BonoboItemContainer</span></a> *container</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Removes the named object from the <em class="parameter"><code>container</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td>The object to operate on.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The name of the object to remove from the container
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-item-container.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="BonoboItemContainer-get-object"></a><h3>The <code class="literal">"get-object"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">BonoboUnknown</span>*      user_function                      (<a class="link" href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="type">BonoboItemContainer</span></a>  *bonoboitemcontainer,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>                *arg1,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              arg2,
                                                        <span class="type">BonoboCorbaException</span> *arg3,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              user_data)                : Run Last</pre>
<p>
Signal emitted when a sub-object is requested from the item container.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bonoboitemcontainer</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>the item name, i.e. the string after the '!' character, usually a semicolon separated list of key=value options
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
<td>the "only_if_exists" flag; if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, client requests that subobject be returned if it exists, but that it should not be created on demand if it doesn't
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
<td>environment, in case the signal wishes to raise an exception
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an object contained by the item container, or <code class="literal">CORBA_OBJECT_NIL</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-item-container.see-also"></a><h2>See Also</h2>
<p>
   <a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="type">BonoboItemHandler</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>